Interface AppWindow

All Superinterfaces:
IPCObject
All Known Implementing Classes:
AppWindowImpl

public interface AppWindow extends IPCObject
Information provided by the PKI file:

    \class AppWindow
    
    \brief AppWindow serves as the entry point to all GUI objects.
    
    \example appWindow()
    
Author:
Auto-generated
  • Method Details

    • getMenuBar

      MenuBar getMenuBar()
      Information provided by the PKI file:
      
          \brief Returns the menu bar.
          
          \return MenuBar, the menu bar widget.
          
              
      Returns:
      MenuBar Returns a MenuBar
    • getToolBar

      ToolBar getToolBar()
      Information provided by the PKI file:
      
          \brief Returns the toolbar.
          
          \return ToolBar, the toolbar widget.
          
              
      Returns:
      ToolBar Returns a ToolBar
    • getSecondaryToolBar

      ToolBar getSecondaryToolBar()
      Information provided by the PKI file:
      
          \brief Returns the secondary toolbar.
          
          \return ToolBar, the toolbar widget.
          
              
      Returns:
      ToolBar Returns a ToolBar
    • getRSSwitch

      RSSwitch getRSSwitch()
      Information provided by the PKI file:
      
          \brief Returns the Realtime/Simulation mode switch.
          
          \return RSSwitch, the Realtime/Simulation mode switch widget.
          
              
      Returns:
      RSSwitch Returns a RSSwitch
    • getPLSwitch

      PLSwitch getPLSwitch()
      Information provided by the PKI file:
      
          \brief Returns the Physical/Logical workspace switch.
          
          \return PLSwitch, the Physical/Logical workspace switch widget.
          
              
      Returns:
      PLSwitch Returns a PLSwitch
    • getLogicalToolbar

      LogicalToolbar getLogicalToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Logical workspace toolbar.
          
          \return LogicalToolbar, the Logical workspace toolbar widget.
          
              
      Returns:
      LogicalToolbar Returns a LogicalToolbar
    • getPhysicalToolbar

      PhysicalToolbar getPhysicalToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Physical workspace toolbar.
          
          \return PhysicalToolbar, the Physical workspace toolbar widget.
          
              
      Returns:
      PhysicalToolbar Returns a PhysicalToolbar
    • getSimulationToolbar

      SimulationToolbar getSimulationToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Simulation mode toolbar.
          
          \return SimulationToolbar, the Simulation mode toolbar widget.
          
              
      Returns:
      SimulationToolbar Returns a SimulationToolbar
    • getRealtimeToolbar

      RealtimeToolbar getRealtimeToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Realtime mode toolbar.
          
          \return RealtimeToolbar, the Realtime mode toolbar widget.
          
              
      Returns:
      RealtimeToolbar Returns a RealtimeToolbar
    • setPLFrameVisible

      void setPLFrameVisible()
    • setRSFrameVisible

      void setRSFrameVisible()
    • getPhysicalLocationDialog

      PhysicalLocationDialog getPhysicalLocationDialog()
      Information provided by the PKI file:
      
          \brief Returns the Physical Location dialog.
          
          \return PhysicalLocationDialog, the Physical Location dialog widget.
          
              
      Returns:
      PhysicalLocationDialog Returns a PhysicalLocationDialog
    • getSimulationPanel

      SimulationPanel getSimulationPanel()
      Information provided by the PKI file:
      
          \brief Returns the Simulation panel.
          
          \return SimulationPanel, the Simulation panel widget.
          
              
      Returns:
      SimulationPanel Returns a SimulationPanel
    • getUserCreatedPDU

      UserCreatedPDU getUserCreatedPDU()
      Information provided by the PKI file:
      
          \brief Returns the User Created PDU.
          
          \return UserCreatedPDU, the User Created PDU widget.
          
              
      Returns:
      UserCreatedPDU Returns a UserCreatedPDU
    • getNetworkComponentBox

      NetworkComponentBox getNetworkComponentBox()
      Information provided by the PKI file:
      
          \brief Returns the Network Component Box.
          
          \return NetworkComponentBox, the NetworkComponentBox widget.
          
              
      Returns:
      NetworkComponentBox Returns a NetworkComponentBox
    • getPDUListWindow

      PDUListWindow getPDUListWindow()
      Information provided by the PKI file:
      
          \brief Returns the PDU list window.
          
          \return PDUListWindow, the PDU List Window widget.
          
              
      Returns:
      PDUListWindow Returns a PDUListWindow
    • getActivityWizard

      ActivityWizard getActivityWizard()
      Information provided by the PKI file:
      
          \brief Returns the Activity Wizard.
          
          \return ActivityWizard, the Activity Wizard widget.
          
              
      Returns:
      ActivityWizard Returns a ActivityWizard
    • getInfoDialog

      InfoDialog getInfoDialog()
      Information provided by the PKI file:
      
          \brief Returns the info dialog.
          
          \return InfoDialog, the Info Dialog widget.
          
              
      Returns:
      InfoDialog Returns a InfoDialog
    • getCommonToolbar

      CommonToolbar getCommonToolbar()
      Information provided by the PKI file:
      
          \brief Returns the Common Toolbar.
          
          \return InfoDialog, the Common Toolbar widget.
          
              
      Returns:
      CommonToolbar Returns a CommonToolbar
    • isSimulationMode

      boolean isSimulationMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Simulation mode, otherwise false.
          
          \return bool, true if currently in Simulation mode, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isRealtimeMode

      boolean isRealtimeMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Realtime mode, otherwise false.
          
          \return bool, true if currently in Realtime mode, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isLogicalMode

      boolean isLogicalMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Logical workspace, otherwise false.
          
          \return bool, true if currently in Logical workspace, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPhysicalMode

      boolean isPhysicalMode()
      Information provided by the PKI file:
      
          \brief Returns true if currently in Physical workspace, otherwise false.
          
          \return bool, true if currently in Physical workspace, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getActiveWorkspace

      Workspace getActiveWorkspace()
      Information provided by the PKI file:
      
          \brief Returns the current active workspace.
          
          \return Workspace, the current active workspace.
          
              
      Returns:
      Workspace Returns a Workspace
    • getActiveDialog

      ActiveDialog getActiveDialog()
      Information provided by the PKI file:
      
          \brief Returns the current active dialog.
          
          \return ActiveDialog, the current active dialog.
          
              
      Returns:
      ActiveDialog Returns a ActiveDialog
    • getAdminDialog

      AdministrativeDialog getAdminDialog()
      Information provided by the PKI file:
      
          \brief Returns the administrative dialog.
          
          \return AdministrativeDialog, the administrative dialog widget.
          
              
      Returns:
      AdministrativeDialog Returns a AdministrativeDialog
    • getPaletteDialog

      PaletteDialog getPaletteDialog()
      Information provided by the PKI file:
      
          \brief Returns the palette dialog.
          
          \return PaletteDialog, the palette dialog widget.
          
              
      Returns:
      PaletteDialog Returns a PaletteDialog
    • getPrintDialog

      PrintDialogPT4 getPrintDialog()
      Information provided by the PKI file:
      
          \brief Returns the print dialog.
          
          \return PrintDialogPT4, the print dialog widget.
          
              
      Returns:
      PrintDialogPT4 Returns a PrintDialogPT4
    • getInstructionDlg

      InstructionDlg getInstructionDlg()
      Information provided by the PKI file:
      
          \brief Returns the activity instructions dialog.
          
          \return InstructionDlg, the activity instructions dialog widget.
          
              
      Returns:
      InstructionDlg Returns a InstructionDlg
    • suppressInstructionDlg

      void suppressInstructionDlg(boolean bSuppress)
      Parameters:
      bSuppress - Takes in a parameter of bSuppress
    • getWebViewManager

      WebViewManager getWebViewManager()
      Information provided by the PKI file:
      
          \brief Returns the WebView manager.
          
          \return WebViewManager, the WebView manager.
          
              
      Returns:
      WebViewManager Returns a WebViewManager
    • getActiveFile

      NetworkFile getActiveFile()
      Information provided by the PKI file:
      
          \brief Returns the current active file.
          
          \return NetworkFile, the current active file.
          
              
      Returns:
      NetworkFile Returns a NetworkFile
    • exit

      void exit()
      Information provided by the PKI file:
      
          \brief Exits Packet Tracer.
          
              
    • exitNoConfirm

      void exitNoConfirm(boolean flag)
      Information provided by the PKI file:
      
          \brief Exits packet tracer with or without save conformation.
          
          \param flag, true to exit Packet Tracer without save confirmation, false to exit with save confirmation.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • getDialogManager

      DialogManager getDialogManager()
      Information provided by the PKI file:
      
          \brief Returns the dialog manager.
          
          \return DialogManager, the dialog manager.
          
              
      Returns:
      DialogManager Returns a DialogManager
    • writeToPT

      void writeToPT(String msg)
      Information provided by the PKI file:
      
          \brief Writes a message to the IPC Log and shows it.
          
          \param msg, the message to write to the IPC Log.
          
              
      Parameters:
      msg - Takes in a parameter of msg
    • getVersion

      String getVersion()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer version number.
          
          \remark     The version includes the major, minor, maintainance
          and possibly build numbers.
          
          \return QString, the Packet Tracer version number.
          
              
      Returns:
      String Returns a String
    • getBasePath

      String getBasePath()
      Information provided by the PKI file:
      
          \brief Returns the installation directory of Packet Tracer.
          
          \return QString, the installation directory of Packet Tracer.
          
              
      Returns:
      String Returns a String
    • fileNew

      boolean fileNew(boolean flag)
      Information provided by the PKI file:
      
          \brief Creates a new file.
          
          \param flag, true shows the save confirmation dialog, false does not.
          
          \return bool, true if a new file was created, otherwise false.
          
              
      Parameters:
      flag - Takes in a parameter of flag
      Returns:
      boolean Returns a boolean
    • fileOpen

      FileOpenReturnValue fileOpen(String filename)
      Information provided by the PKI file:
      
          \brief Opens the specified file.
          
          \param filename, the path of the file.
          
          \return EFileOpenReturnValue
          Can be of the following values:
          eFileReturnOk,
          eFileReturnBadSSL,
          eFileReturnBadDecompress,
          eFileReturnBadBinary,
          eFileReturnBadMetafile,
          eFileReturnBadConfiguration,
          eFileReturnUnableToReadFile,
          eFileReturnBadOptions,
          eFileReturnUserCancel
          
              
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • promptFileOpenFolder

      FileOpenReturnValue promptFileOpenFolder(String folder)
      Information provided by the PKI file:
      
          \brief Prompts to browse a folder for a file to open.
          
          \param folder, the path of the folder to browse.
          
          \return EFileOpenReturnValue
          Can be of the following values:
          eFileReturnOk,
          eFileReturnBadSSL,
          eFileReturnBadDecompress,
          eFileReturnBadBinary,
          eFileReturnBadMetafile,
          eFileReturnBadConfiguration,
          eFileReturnUnableToReadFile,
          eFileReturnBadOptions,
          eFileReturnUserCancel
          
              
      Parameters:
      folder - Takes in a parameter of folder
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • getListOfFilesToOpen

      List<String> getListOfFilesToOpen(String location)
      Information provided by the PKI file:
      
          \brief Retrives list of files that can be opened location.
          \param location, Reserved
          \return List of files that can be opened.
          
              
      Parameters:
      location - Takes in a parameter of location
      Returns:
      List<String> Returns a List<String>
    • getListOfFilesSaved

      List<String> getListOfFilesSaved(String location)
      Information provided by the PKI file:
      
          \brief Retrives list of files saved at default location.
          \param location, Reserved
          \return List of files that can be opened.
          
              
      Parameters:
      location - Takes in a parameter of location
      Returns:
      List<String> Returns a List<String>
    • getDefaultFileSaveLocation

      String getDefaultFileSaveLocation()
      Information provided by the PKI file:
      
          \brief Retrives default save location
          \return Returns default save location
          
              
      Returns:
      String Returns a String
    • getTempFileLocation

      String getTempFileLocation()
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsync() and register to fileSaveDone() event.
          
              
      Returns:
      String Returns a String
    • fileSave

      boolean fileSave()
      Returns:
      boolean Returns a boolean
    • fileSaveAsync

      void fileSaveAsync()
      Information provided by the PKI file:
      
          \brief Starts save operation and returns immediately.
          
          \remark Register to fileSaveDone() event to get the status.
          
              
    • fileSaveAs

      boolean fileSaveAs(String filename)
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsAsync() and register to fileSaveDone() event.
          
              
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      boolean Returns a boolean
    • fileSaveAsAsync

      void fileSaveAsAsync(String filename)
      Information provided by the PKI file:
      
          \brief Starts save as operation to the specified file and returns immediately.
          
          \param filename, the path of the file.
          
          \remark Register to fileSaveDone() event to get the status.
          
              
      Parameters:
      filename - Takes in a parameter of filename
    • fileSaveAsNoPrompt

      void fileSaveAsNoPrompt(String filename, boolean bAsync)
      Information provided by the PKI file:
      
          \brief Same as fileSaveAs() except it does not prompt to overwrite the file
          
          \param filename, the path of the file.
          
          \param bAsync, set to true to use fileSaveAsAsync()
          
          \remark Register to fileSaveDone() event to get the status.
          
              
      Parameters:
      filename - Takes in a parameter of filename
      bAsync - Takes in a parameter of bAsync
    • fileSaveAsPkz

      boolean fileSaveAsPkz(String filename)
      Information provided by the PKI file:
      
          \deprecated Use fileSaveAsPkzAsync() and register to fileSaveDone() event.
          
              
      Parameters:
      filename - Takes in a parameter of filename
      Returns:
      boolean Returns a boolean
    • fileSaveAsPkzAsync

      void fileSaveAsPkzAsync(String filename)
      Information provided by the PKI file:
      
          \brief Starts save as pkz operation and returns immediately.
          
          \param filename, the path of the file.
          
          \remark Register to fileSaveDone() to get the status.
          
              
      Parameters:
      filename - Takes in a parameter of filename
    • fileActivityWizard

      void fileActivityWizard()
      Information provided by the PKI file:
      
          \brief Enters the Activity Wizard.
          
              
    • fileOpenFromURL

      FileOpenReturnValue fileOpenFromURL(String url)
      Information provided by the PKI file:
      
          \brief Opens a file at the specified URL.
          
          \param url, the URL of the file.
          
          \return bool, true if the file was opened, otherwise false.
          
              
      Parameters:
      url - Takes in a parameter of url
      Returns:
      FileOpenReturnValue Returns a FileOpenReturnValue
    • fileSaveToBytes

      List<Byte> fileSaveToBytes()
      Information provided by the PKI file:
      
          \deprecated Use fileSaveToBytesAsync() and register to fileSaveToBytesDone().
          
              
      Returns:
      List<Byte> Returns a List<Byte>
    • fileSaveToBytesAsync

      void fileSaveToBytesAsync()
      Information provided by the PKI file:
      
          \brief Starts save to bytes operation and returns immediately.
          
          \remark Register to fileSaveToBytesDone() event to get save in bytes.
          
              
    • shouldIgnoreFileNew

      boolean shouldIgnoreFileNew()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->new action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->new action.
          
              
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileOpenFolder

      boolean shouldIgnoreFileOpenFolder(String folder)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->open folder action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg folder, the folder the user wants to browse for files to open.
          
          \return bool, true if PT should ignore the file->open folder action.
          
              
      Parameters:
      folder - Takes in a parameter of folder
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileOpenRecent

      boolean shouldIgnoreFileOpenRecent(String file)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->open recent file action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg file, the path of the recent file to open.
          
          \return bool, true if PT should ignore the file->open recent file action.
          
              
      Parameters:
      file - Takes in a parameter of file
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileSave

      boolean shouldIgnoreFileSave()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->save action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->save action.
          
              
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileSaveAs

      boolean shouldIgnoreFileSaveAs(String file)
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->save as action.
          If ignoring, then the script module should do something to let the user know.
          
          \arg file, the file to save as
          
          \return bool, true if PT should ignore the file->save as action.
          
              
      Parameters:
      file - Takes in a parameter of file
      Returns:
      boolean Returns a boolean
    • shouldIgnoreFileExit

      boolean shouldIgnoreFileExit()
      Information provided by the PKI file:
      
          \brief This delegate determines if PT should ignore the file->exit action.
          If ignoring, then the script module should do something to let the user know.
          
          \return bool, true if PT should ignore the file->exit action.
          
              
      Returns:
      boolean Returns a boolean
    • isPreventClose

      boolean isPreventClose()
      Information provided by the PKI file:
      
          \brief Returns true if Packet Tracer is prevented from closing, otherwise false.
          
          \return bool, true if Packet Tracer is prevented from closing, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setPreventClose

      void setPreventClose(boolean bPreventClose)
      Information provided by the PKI file:
      
          \brief Allows or prevents Packet Tracer from closing.
          
          \param bPreventClose, true to prevent Packet Tracer from closing, false to allow closing.
          
              
      Parameters:
      bPreventClose - Takes in a parameter of bPreventClose
    • getProcessId

      long getProcessId()
      Information provided by the PKI file:
      
          \brief Returns Packet Tracer application process ID.
          
          \return long, Packet Tracer application process ID.
          
              
      Returns:
      long Returns a long
    • getSessionId

      String getSessionId()
      Information provided by the PKI file:
      
          \brief Returns the globally unique Packet Tracer application session ID.
          
          \return QString, the globally unique Packet Tracer application session ID.
          
              
      Returns:
      String Returns a String
    • getUserFolder

      String getUserFolder()
      Information provided by the PKI file:
      
          \brief Returns the user folder of the current user logged into the OS.
          
          \return QString, the user folder of the current user logged into the OS.
          
              
      Returns:
      String Returns a String
    • setVisible

      void setVisible(boolean flag)
      Information provided by the PKI file:
      
          \brief This event is emitted when a message box should be displayed.
          \NOT APPLICABLE TO DESKTOP
          event: popupMessage(QString reason, QString title, QString message, QString buttonA, QString buttonB, QString buttonC, QString buttonD) - PrivApplication;
          
          \brief Shows or hides the Packet Tracer main window.
          
          \param flag, true to show the Packet Tracer main window, false to hide it.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • raise

      void raise()
    • setDisabled

      void setDisabled(boolean flag)
      Information provided by the PKI file:
      
          \brief Disables or enables the application.  Buttons, etc will be shown as disabled and unuable.
          
          \param flag, true to disable the application and false to enable.
          
              
      Parameters:
      flag - Takes in a parameter of flag
    • isMaximized

      void isMaximized()
      Information provided by the PKI file:
      
          \brief Returns whether the Packet Tracer main window is maximized.
          
              
    • showMaximized

      void showMaximized()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the maximum size.
          
              
    • isMinimized

      void isMinimized()
      Information provided by the PKI file:
      
          \brief Returns whether the Packet Tracer main window is minimized.
          
              
    • showMinimized

      void showMinimized()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the minimum size.
          
              
    • showNormal

      void showNormal()
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window to the normal size.
          
              
    • setWindowTitle

      void setWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window title.
          
          \param title, the window title
          
              
      Parameters:
      title - Takes in a parameter of title
    • setWindowGeometry

      void setWindowGeometry(int x, int y, int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the Packet Tracer main window geometry and position.
          
          \param x, the x-coordinate of the main window.
          \param y, the y-coordinate of the main window.
          \param width, the width of the main window.
          \param height, the height of the main window.
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getX

      int getX()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window x-coorindate.
          
          \return int, the Packet Tracer main window x-coorindate.
          
              
      Returns:
      int Returns a int
    • getY

      int getY()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window y-coorindate.
          
          \return int, the Packet Tracer main window y-coorindate.
          
              
      Returns:
      int Returns a int
    • getWidth

      int getWidth()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window width.
          
          \return int, the Packet Tracer main window width.
          
              
      Returns:
      int Returns a int
    • getHeight

      int getHeight()
      Information provided by the PKI file:
      
          \brief Returns the Packet Tracer main window height.
          
          \return int, the Packet Tracer main window height.
          
              
      Returns:
      int Returns a int
    • setMaximumSize

      void setMaximumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum size of the Packet Tracer main window.
          
              
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMaximumWidth

      void setMaximumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the maximum width of the Packet Tracer main window.
          
              
      Parameters:
      width - Takes in a parameter of width
    • setMaximumHeight

      void setMaximumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum height of the Packet Tracer main window.
          
              
      Parameters:
      height - Takes in a parameter of height
    • getMaximumWidth

      int getMaximumWidth()
      Information provided by the PKI file:
      
          \brief Returns the maximum width of the Packet Tracer main window.
          
              
      Returns:
      int Returns a int
    • getMaximumHeight

      int getMaximumHeight()
      Information provided by the PKI file:
      
          \brief Returns the maximum height of the Packet Tracer main window.
          
              
      Returns:
      int Returns a int
    • setMinimumSize

      void setMinimumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum size of the Packet Tracer main window.
          
              
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMinimumWidth

      void setMinimumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the minimum width of the Packet Tracer main window.
          
              
      Parameters:
      width - Takes in a parameter of width
    • setMinimumHeight

      void setMinimumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum height of the Packet Tracer main window.
          
              
      Parameters:
      height - Takes in a parameter of height
    • getMinimumWidth

      int getMinimumWidth()
      Information provided by the PKI file:
      
          \brief Returns the minimum width of the Packet Tracer main window.
          
              
      Returns:
      int Returns a int
    • getMinimumHeight

      int getMinimumHeight()
      Information provided by the PKI file:
      
          \brief Returns the minimum height of the Packet Tracer main window.
          
              
      Returns:
      int Returns a int
    • getMainViewAreaWidth

      int getMainViewAreaWidth()
      Information provided by the PKI file:
      
          \brief Returns the main view area's width.
          
          \return int, the main view area's width.
          
              
      Returns:
      int Returns a int
    • getMainViewAreaHeight

      int getMainViewAreaHeight()
      Information provided by the PKI file:
      
          \brief Returns the main view area's height.
          
          \return int, the main view area's height.
          
              
      Returns:
      int Returns a int
    • isInterfaceLocked

      boolean isInterfaceLocked(String ID, String branchID1, String branchID2)
      Information provided by the PKI file:
      
          \brief Returns true if the interface with the specified ID is locked, otherwise false.
          
          \param ID, the ID of the item to check if locked.
          \param branchID1, limit the search to this branch ID.
          \param branchID2, limit the search to this branch ID of branchID1.
          
          \return bool, true if the interface with the specified ID is locked, otherwise false.
          
              
      Parameters:
      ID - Takes in a parameter of ID
      branchID1 - Takes in a parameter of branchID1
      branchID2 - Takes in a parameter of branchID2
      Returns:
      boolean Returns a boolean
    • setClipboardText

      void setClipboardText(String text)
      Information provided by the PKI file:
      
          \brief Sets the clipboard text(copy/paste text) to the given text.
          
          \param text, text to put on the clipboard to use for paste.
          
              
      Parameters:
      text - Takes in a parameter of text
    • getClipboardText

      String getClipboardText()
      Information provided by the PKI file:
      
          \brief Returns the current clipboard text, if any.
          
          \return QString, text stored in the copy/paste clipboard.
          
              
      Returns:
      String Returns a String
    • helpPath

      void helpPath(String subPath)
      Information provided by the PKI file:
      
          \brief Open a help file at the given path.
          
          \param subPath, subpath to the file to open.
          
              
      Parameters:
      subPath - Takes in a parameter of subPath
    • openURL

      boolean openURL(String url)
      Information provided by the PKI file:
      
          \brief Open URL in external web browser.
          
          \param url, url to open.
          
              
      Parameters:
      url - Takes in a parameter of url
      Returns:
      boolean Returns a boolean
    • getEnvironmentDialog

      EnvironmentDialog getEnvironmentDialog()
      Information provided by the PKI file:
      
          \brief Returns the Environment Dialog.
          
          \return Environment Dialog
          
              
      Returns:
      EnvironmentDialog Returns a EnvironmentDialog
    • listDirectory

      List<String> listDirectory(String location, String filter)
      Information provided by the PKI file:
      
          \brief Temporary function used to update sample files.  Not for normal use.
          
              
      Parameters:
      location - Takes in a parameter of location
      filter - Takes in a parameter of filter
      Returns:
      List<String> Returns a List<String>
    • setCheckOutdatedDevices

      void setCheckOutdatedDevices(boolean bCheck)
      Information provided by the PKI file:
      
          \brief Set if devices marked as outdated should be displayed for selection.
          
          \param bCheck, true if outdated devices should be handled when setting up the toolbar, false if not.
          
              
      Parameters:
      bCheck - Takes in a parameter of bCheck
    • deletePTConf

      void deletePTConf()
    • getPTSAMode

      String getPTSAMode()
      Information provided by the PKI file:
      
          \brief Get the current PTSA Mode.
          
          \return QString, current PTSA Mode.
          
              
      Returns:
      String Returns a String
    • setPTSAMode

      void setPTSAMode(String ptsaMode)
      Information provided by the PKI file:
      
          \brief Get the current PTSA Mode.
          
          \return QString, current PTSA Mode.
          
              
      Parameters:
      ptsaMode - Takes in a parameter of ptsaMode
    • isPTSA

      boolean isPTSA()
      Information provided by the PKI file:
      
          \brief returns true if PTSA
          
          \return bool, true if PTSA.
          
              
      Returns:
      boolean Returns a boolean
    • setPTSAPluginVisible

      void setPTSAPluginVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief show and hide pt window, called from ptsa plugin only. you still need to clear other windows, possibly with file->new
          
          \return
          
              
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • isActivityWizardOpen

      boolean isActivityWizardOpen()
      Returns:
      boolean Returns a boolean